QueryInvoiceQueryAmounts
The CreateInvoiceQueryAmount web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables Query Amounts to be queried for a given Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. or Account/Invoice Number combination. That is, if an Invoice Number is supplied, Query Amounts pertaining to that specific Account and Invoice are returned as opposed to a list for the whole CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Account. This web service is used in conjunction with other web services in order to create, query and resolve Query Amounts.
If only a valid Account Number is specified, all Query Amounts logged against that Account are retrieved. Results are filtered by the Status Filter. Select All to return all Query Amounts or Open for Open Query Amounts.
If the Account Number and Invoice Number are specified, retrieved Query Amounts are restricted to those matching these fields. The Status Filter determines which individual query records are included in the response.
Submission of invalid data results in an appropriate error being returned.
QueryInvoiceQueryAmounts Request
The QueryInvoiceQueryAmounts tag instructs the Query Invoice Query Amounts service to query invoice query amounts. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
AccountNumber |
Integer8 |
The unique number automatically generated when the Account is created. |
Mandatory |
|
InvoiceNumber |
Integer8 |
Invoice Number to which the query belongs. |
Optional |
|
StatusFilter |
String |
One of:
|
Mandatory |
QueryInvoiceQueryAmounts Response
The QueryInvoiceQueryAmounts response container is the response to the QueryInvoiceQueryAmounts Request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
AccountNumber |
Integer8 |
The unique number automatically generated when the Account is created. |
Mandatory |
|
QueryAmounts |
Container |
See Query Data Response Container for details. |
Optional |
If no Query Amounts are found, standard exception processing applies.
InvoiceQueryAmounts Response Container
The InvoiceQueryAmounts response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
InvoiceQueryAmounts |
Container |
See InvoiceQueryAmount Response Container for details. |
Optional |
InvoiceQueryAmounts
The InvoiceQueryAmount response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
QueryNumber |
Integer8 |
Query number used to identify the query. |
Optional |
|
AmountsInQuery |
Currency (Decimal) |
|
Optional |
|
DateQueryRaised |
Date |
The date on which the query was raised. YYYY-MM-DDZ |
Optional |
|
InvoiceNumber |
Integer8 |
Invoice Number to which the query belongs. |
Optional |
|
WorkflowEventNumber |
Integer9 |
The Workflow Event Number associated with this query. |
Optional |
|
QueryStatus |
String |
Either:
|
Optional |
|
CreatedBy |
String30 |
The system identifier of the user who created the query event. |
Optional |